Esx Settings AlternativeImageSpec
The Esx Settings AlternativeImageSpec schema contains properties that describes an alternative image for the desired software specification.
This schema was added in vSphere API 9.0.0.0.
{
"base_image": {
"version": "string"
},
"add_on": {
"name": "string",
"version": "string"
},
"components": {
"components": "string"
},
"solutions": {
"solutions": {
"version": "string",
"components": [
{
"component": "string"
}
]
}
},
"hardware_support": {
"packages": {
"packages": {
"pkg": "string",
"version": "string"
}
}
},
"removed_components": [
"string"
],
"display_name": "string",
"selection_criteria": {
"selection_type": "string",
"host_uuids": [
"string"
],
"host_hardware_spec": {
"vendor": "string",
"models": [
"string"
],
"families": [
"string"
],
"oem_strings": [
"string"
]
}
}
}Base image of the ESX.
This property was added in vSphere API 9.0.0.0.
OEM customization on top of given base-image. The components in this customization override the components in the base base-image.
This property was added in vSphere API 9.0.0.0.
If missing or null, no OEM customization will be applied.
Additional components which should be part of the software specification. If value is not given for a particular component then version for that component will be picked from the constraints. These override the components present in Esx Settings AlternativeImageSpec.add_on and Esx Settings AlternativeImageSpec.base_image.
This property was added in vSphere API 9.0.0.0.
If missing or null, no additional components will be installed.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.component. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.component.
Mapping from solution identifier to the solution specification. The key is the solution name and the value is the specification detailing components registered by that solution.
This property was added in vSphere API 9.0.0.0.
If missing or null, no solutions will be part of the software specification.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.esx.settings.solution. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.esx.settings.solution.
Information about the Hardware Support Package (HSP) configured in the software specification.
This property was added in vSphere API 9.0.0.0.
If missing or null or empty, no firmware compliance checking or remediation will be done.
Components to be removed from the software specification.
This property was added in vSphere API 9.0.0.0.
If missing or null no component will be removed.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.esx.settings.component. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.esx.settings.component.
Display name of the Alternative Image. Supported encoding is UTF-8.
This property was added in vSphere API 9.0.0.0.
Selection criteria used to select the alternative image for 1 or more hosts
This property was added in vSphere API 9.0.0.0.